|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Note: This class/interface is part of an interim API that is still under
development and expected to change significantly before reaching stability.
It is being made available at this early stage to solicit feedback from pioneering
adopters on the understanding that any code that uses this API will almost
certainly be broken (repeatedly) as the API evolves.
A ILocalSyncElement
describes the relative synchronization of a local
resource using a base resource for comparison.
Differences between the base and local resources are classified as outgoing changes; if there is a difference, the local resource is considered the outgoing resource.
IRemoteSyncElement
Field Summary | |
static int |
ADDITION
Sync constant (value 1) indicating that one side was added. |
static int |
AUTOMERGE_CONFLICT
Sync constant (value 32) indicating that both the local and remote resources have changed relative to the base but their content changes do not conflict (e.g. |
static int |
CHANGE
Sync constant (value 3) indicating that one side was changed. |
static int |
CHANGE_MASK
Bit mask for extracting the change type. |
static int |
CONFLICTING
Sync constant (value 12) indicating a change to both the remote and local resources. |
static int |
DELETION
Sync constant (value 2) indicating that one side was deleted. |
static int |
DIRECTION_MASK
Bit mask for extracting the synchronization direction. |
static int |
GRANULARITY_CONTENTS
Constant (value 2) indicating to consider file contents when calculating the synchronization kind. |
static int |
GRANULARITY_CONTENTS_IGNORE_WHITESPACE
Constant (value 4) indicating to consider file contents (potentially ignoring whitespace) when calculating the synchronization kind. |
static int |
GRANULARITY_TIMESTAMP
Constant (value 1) to only consider timestamp comparisons (e.g. |
static int |
IN_SYNC
Sync constant (value 0) indicating element is in sync. |
static int |
INCOMING
Sync constant (value 8) indicating a change to the remote resource. |
static int |
MANUAL_CONFLICT
Sync constant (value 64) indicating that both the local and remote resources have changed relative to the base and their content changes conflict (e.g. |
static int |
OUTGOING
Sync constant (value 4) indicating a change to the local resource. |
static int |
PSEUDO_CONFLICT
Sync constant (value 16) indication that both the local and remote resources have changed relative to the base but their contents are the same. |
Method Summary | |
IRemoteResource |
getBase()
Answers the base sync element of this node. |
IResource |
getLocal()
Answers the local sync element of this node. |
String |
getName()
Answer a string that describes the simple name of the sync node, which is suitable for display to a user. |
int |
getSyncKind(int granularity,
IProgressMonitor progress)
Performs a synchronization calculation on the given element based on the local and base resources. |
boolean |
isContainer()
Answer if the sync node is a container and may have children. |
ILocalSyncElement[] |
members(IProgressMonitor monitor)
Answers and array of ILocalSyncElement elements that are immediate
children of this sync element, in no particular order. |
Field Detail |
public static final int IN_SYNC
public static final int ADDITION
public static final int DELETION
public static final int CHANGE
public static final int CHANGE_MASK
public static final int OUTGOING
public static final int INCOMING
public static final int CONFLICTING
public static final int DIRECTION_MASK
public static final int PSEUDO_CONFLICT
public static final int AUTOMERGE_CONFLICT
public static final int MANUAL_CONFLICT
public static final int GRANULARITY_TIMESTAMP
public static final int GRANULARITY_CONTENTS
public static final int GRANULARITY_CONTENTS_IGNORE_WHITESPACE
Method Detail |
public String getName()
public boolean isContainer()
true
if the remote resource is a container, and
false
if it is not.public IResource getLocal()
public IRemoteResource getBase()
null
if there is no base (e.g. conflicting add).
null
is there
is none.public ILocalSyncElement[] members(IProgressMonitor monitor) throws TeamException
ILocalSyncElement
elements that are immediate
children of this sync element, in no particular order. The returned sync nodes are
a combination of the nodes represented by the sync element (e.g. local, base, remote).
monitor
- a progress monitor to indicate the duration of the operation, or
null
if progress reporting is not required.
TeamException
public int getSyncKind(int granularity, IProgressMonitor progress)
granularity
- the granularity at which the elements of this sync element
should be compared. On of GRANULARITY_TIMESTAMP
, or
GRANULARITY_CONTENTS
.progress
- a progress monitor to indicate the duration of the operation, or
null
if progress reporting is not required.
|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |